<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Docs For Class Madoqua_Form</title>
    <link rel="stylesheet" type="text/css" href="../media/style.css" />
    <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  </head>
  <body>
  
    <h1>Madoqua :: Docs For Class Madoqua_Form</h1>

    <table width="100%">
      <tr valign="top">
        <td class="menu">
                                <div class="package">
              <div id="todolist">
                <p><a href="../todolist.html">Todo List</a></p>
              </div>
            </div>
                    <h2>Packages:</h2>
          <div class="package">
            <ul>
                              <li>
                  <a href="../classtrees_default.html">default</a>
                </li>
                              <li>
                  <a href="../classtrees_Application.html">Application</a>
                </li>
                              <li>
                  <a href="../classtrees_Cache.html">Cache</a>
                </li>
                              <li>
                  <a href="../classtrees_Controller.html">Controller</a>
                </li>
                              <li>
                  <a href="../classtrees_Db.html">Db</a>
                </li>
                              <li>
                  <a href="../classtrees_Filter.html">Filter</a>
                </li>
                              <li>
                  <a href="../classtrees_Form.html">Form</a>
                </li>
                              <li>
                  <a href="../classtrees_Install.html">Install</a>
                </li>
                              <li>
                  <a href="../classtrees_Loader.html">Loader</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Exception.html">Madoqua_Exception</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Observer.html">Madoqua_Observer</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Plugin.html">Madoqua_Plugin</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_View.html">Madoqua_View</a>
                </li>
                              <li>
                  <a href="../classtrees_Module.html">Module</a>
                </li>
                              <li>
                  <a href="../classtrees_Naneau_Plugin.html">Naneau_Plugin</a>
                </li>
                              <li>
                  <a href="../classtrees_Redirector.html">Redirector</a>
                </li>
                              <li>
                  <a href="../classtrees_Search.html">Search</a>
                </li>
                              <li>
                  <a href="../classtrees_Validate.html">Validate</a>
                </li>
                              <li>
                  <a href="../classtrees_View.html">View</a>
                </li>
                          </ul>
          </div>
                                                                    <h2>Classes:</h2>
                <ul>
		    		<li><a href="../Form/Madoqua_Form.html">Madoqua_Form</a></li>    	  </ul>
                              </td>
        <td>
          <table style="width:750px;" cellpadding="10" cellspacing="10px">
            <tr>
              <td valign="top">
                                                                  <h2>Form::Madoqua_Form</h2>
                                <div class="menu">
          
                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                        [ <a href="../index.html">Index</a> ]
                      [ <a href="../classtrees_Form.html">Form classes</a> ]
            [ <a href="../elementindex_Form.html">Form elements</a> ]
                    [ <a href="../elementindex.html">All elements</a> ]
          [ <a href="../errors.html">Errors</a> ]
                </div>
<a name="sec-description"></a>
<h2>Class Madoqua_Form</h2>

<p>Madoqua_Form</p>		


<pre>Zend_Form
   |
   --Madoqua_Form</pre>










  <a name="sec-method-summary"></a>
  <h2>Method Summary</h2>
  <table class="summary">
                                                                                                                                    <tr>
          <td class="right">
            <em>public</em>                        <em>Madoqua_Form</em>          </td>
          <td>
            <code>
              <a href="#__construct"><b>__construct</b></a>(
                                                                  [                  $options
                   = null]                               )
            </code>
            <br /><div style="margin-left: 20px">constructor</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#cleanPrgData"><b>cleanPrgData</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">clean prg data (so prg won't repeatedly be true)</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>                        <em>int</em>          </td>
          <td>
            <code>
              <a href="#getExistingPrgKey"><b>getExistingPrgKey</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get a PRG key from the session</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#getModelValues"><b>getModelValues</b></a>(
                                                                                    $model
                                                 )
            </code>
            <br /><div style="margin-left: 20px">get values matching a model</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>array</em>          </td>
          <td>
            <code>
              <a href="#getPrgData"><b>getPrgData</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get prg data (to be used with isValid())</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>                        <em>int</em>          </td>
          <td>
            <code>
              <a href="#getPrgKey"><b>getPrgKey</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get a prg key</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>array</em>          </td>
          <td>
            <code>
              <a href="#getValues"><b>getValues</b></a>(
                                                                  [                  $exclude
                   = array()]                                  ,                   [                  $includeSubmits
                   = false]                               )
            </code>
            <br /><div style="margin-left: 20px">get form values</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>bool</em>          </td>
          <td>
            <code>
              <a href="#isPosted"><b>isPosted</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">has this form been posted?</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>bool</em>          </td>
          <td>
            <code>
              <a href="#isPrg"><b>isPrg</b></a>(
                                                                  [                  $url
                   = null]                                  ,                   [                  $checkFormName
                   = false]                               )
            </code>
            <br /><div style="margin-left: 20px">check whether the form has been prg-ed</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>bool</em>          </td>
          <td>
            <code>
              <a href="#isValidPrg"><b>isValidPrg</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">PRG version of isValid()</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#setRouteAction"><b>setRouteAction</b></a>(
                                                                  [                  $params
                   = array()]                                  ,                   [                  $routeName
                   = null]                                  ,                   [                  $reset
                   = false]                               )
            </code>
            <br /><div style="margin-left: 20px">set the action based on a route</div>          </td>
        </tr>
            </table>


  <a name="sec-methods"></a>
  <h2>Methods</h2>
  <a name='method_detail'></a>
                      
      <a name="method__construct" id="__construct"><!-- --></a>

    <h3>__construct</h3>

    <div class="method-signature">
      Madoqua_Form
      __construct(
                                  [
          $options
           = null]              )
    </div>

    <p>constructor</p>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$options</code></td>
              <td><em></em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
        <a name="methodcleanPrgData" id="cleanPrgData"><!-- --></a>

    <h3>cleanPrgData</h3>

    <div class="method-signature">
      void
      cleanPrgData(
      )
    </div>

    <p>clean prg data (so prg won't repeatedly be true)</p>
    
        

    
    
    
        <a name="methodgetExistingPrgKey" id="getExistingPrgKey"><!-- --></a>

    <h3>getExistingPrgKey</h3>

    <div class="method-signature">
      int
      getExistingPrgKey(
      )
    </div>

    <p>get a PRG key from the session</p>
    
        

    
    
    
        <a name="methodgetModelValues" id="getModelValues"><!-- --></a>

    <h3>getModelValues</h3>

    <div class="method-signature">
      void
      getModelValues(
                                  Zend_Db_Table
          $model
                        )
    </div>

    <p>get values matching a model</p>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$model</code></td>
              <td><em>Zend_Db_Table</em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
        <a name="methodgetPrgData" id="getPrgData"><!-- --></a>

    <h3>getPrgData</h3>

    <div class="method-signature">
      array
      getPrgData(
      )
    </div>

    <p>get prg data (to be used with isValid())</p>
    
        

    
    
    
        <a name="methodgetPrgKey" id="getPrgKey"><!-- --></a>

    <h3>getPrgKey</h3>

    <div class="method-signature">
      int
      getPrgKey(
      )
    </div>

    <p>get a prg key</p>
    
        

    
    
    
        <a name="methodgetValues" id="getValues"><!-- --></a>

    <h3>getValues</h3>

    <div class="method-signature">
      array
      getValues(
                                  [array
          $exclude
           = array()]                  ,           [bool
          $includeSubmits
           = false]              )
    </div>

    <p>get form values</p>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$exclude</code></td>
              <td><em>array</em></td>
              <td>
                              </td>
            </tr>
                      <tr>
              <td><code>$includeSubmits</code></td>
              <td><em>bool</em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
        <a name="methodisPosted" id="isPosted"><!-- --></a>

    <h3>isPosted</h3>

    <div class="method-signature">
      bool
      isPosted(
      )
    </div>

    <p>has this form been posted?</p><div><p>will not start validation loop</p></div>
    
        

    
    
    
        <a name="methodisPrg" id="isPrg"><!-- --></a>

    <h3>isPrg</h3>

    <div class="method-signature">
      bool
      isPrg(
                                  [string
          $url
           = null]                  ,           [
          $checkFormName
           = false]              )
    </div>

    <p>check whether the form has been prg-ed</p><div><p>also performs the redirect logic</p></div>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$url</code></td>
              <td><em>string</em></td>
              <td>
                                  url to redirect to
                              </td>
            </tr>
                      <tr>
              <td><code>$checkFormName</code></td>
              <td><em></em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
        <a name="methodisValidPrg" id="isValidPrg"><!-- --></a>

    <h3>isValidPrg</h3>

    <div class="method-signature">
      bool
      isValidPrg(
      )
    </div>

    <p>PRG version of isValid()</p>
    
        

    
    
    
        <a name="methodsetRouteAction" id="setRouteAction"><!-- --></a>

    <h3>setRouteAction</h3>

    <div class="method-signature">
      void
      setRouteAction(
                                  [array
          $params
           = array()]                  ,           [string
          $routeName
           = null]                  ,           [bool
          $reset
           = false]              )
    </div>

    <p>set the action based on a route</p>
          <h4>Parameters:</h4>
      <table class="detail">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th class="desc">Description</th>
          </tr>
        </thead>
        <tbody>
                      <tr>
              <td><code>$params</code></td>
              <td><em>array</em></td>
              <td>
                              </td>
            </tr>
                      <tr>
              <td><code>$routeName</code></td>
              <td><em>string</em></td>
              <td>
                              </td>
            </tr>
                      <tr>
              <td><code>$reset</code></td>
              <td><em>bool</em></td>
              <td>
                              </td>
            </tr>
                  </tbody>
      </table>
    
        

    
    
    
  
<p class="notes">
  Located in <a class="field" href="_Form.php.html">/Form.php</a> 
  [<span class="field">line 24</span>]
</p>

                <div class="credit">
                  Documentation generated on Fri, 16 Jan 2009 10:14:41 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
                </div>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </body>
</html>